<html>
<head><meta charset="utf-8"><title>compiler internals: doc links · t-compiler · Zulip Chat Archive</title></head>
<h2>Stream: <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/index.html">t-compiler</a></h2>
<h3>Topic: <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/compiler.20internals.3A.20doc.20links.html">compiler internals: doc links</a></h3>

<hr>

<base href="https://rust-lang.zulipchat.com">

<head><link href="https://rust-lang.github.io/zulip_archive/style.css" rel="stylesheet"></head>

<a name="200609082"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/compiler%20internals%3A%20doc%20links/near/200609082" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> lcnr <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/compiler.20internals.3A.20doc.20links.html#200609082">(Jun 11 2020 at 21:30)</a>:</h4>
<p>Afaict we don't use doc links inside of the compiler. Is there a specific reason for this?</p>



<a name="200609365"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/compiler%20internals%3A%20doc%20links/near/200609365" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> lcnr <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/compiler.20internals.3A.20doc.20links.html#200609365">(Jun 11 2020 at 21:32)</a>:</h4>
<p>I.e. </p>
<div class="codehilite"><pre><span></span><code>/// To create this, use [`Bar::make_foo`](struct.Bar.html#method.make_foo).
struct Foo;
</code></pre></div>



<a name="200609575"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/compiler%20internals%3A%20doc%20links/near/200609575" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Matthew Jasper <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/compiler.20internals.3A.20doc.20links.html#200609575">(Jun 11 2020 at 21:33)</a>:</h4>
<p>They didn't exist for a long time. No one remembers to use them for now, and I don't think that we fail the build if they break.</p>



<a name="200610255"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/compiler%20internals%3A%20doc%20links/near/200610255" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> lcnr <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/compiler.20internals.3A.20doc.20links.html#200610255">(Jun 11 2020 at 21:39)</a>:</h4>
<p>Would checking the links be a useful part of CI? IIRC rustc-dev-guide does so, which broke CI when an unrelated website went offline <span aria-label="thinking" class="emoji emoji-1f914" role="img" title="thinking">:thinking:</span> <br>
So I don't know if this tradeoff is worth it for the compiler itself.</p>



<a name="200703080"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/compiler%20internals%3A%20doc%20links/near/200703080" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> mark-i-m <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/compiler.20internals.3A.20doc.20links.html#200703080">(Jun 12 2020 at 17:58)</a>:</h4>
<p>It might break less for the docs because most of the links are internal and don't require network to check</p>



<a name="200703131"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/compiler%20internals%3A%20doc%20links/near/200703131" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> mark-i-m <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/compiler.20internals.3A.20doc.20links.html#200703131">(Jun 12 2020 at 17:59)</a>:</h4>
<p>whereas rustc-dev-guide has hundreds of external links</p>



<a name="200746669"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/131828-t-compiler/topic/compiler%20internals%3A%20doc%20links/near/200746669" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Tshepang Lekhonkhobe <a href="https://rust-lang.github.io/zulip_archive/stream/131828-t-compiler/topic/compiler.20internals.3A.20doc.20links.html#200746669">(Jun 13 2020 at 03:24)</a>:</h4>
<p>them going breaking hampers learning, and are more easily fixed by someone working on the code that resulted in breakage</p>



<hr><p>Last updated: Aug 07 2021 at 22:04 UTC</p>
</html>